Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Move RequestEventLocals type definition into a namespace to make the retyping easier for users #1469

Open
wants to merge 12 commits into
base: main
Choose a base branch
from
Open

Move RequestEventLocals type definition into a namespace to make the retyping easier for users #1469

wants to merge 12 commits into from
+22 −15

Conversation

AirBorne04
Copy link
Contributor

@AirBorne04 AirBorne04 commented May 5, 2024 •
edited
Loading

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

  • Other... Type changes that require minor adjustments

What is the current behavior?

When defining a RequestEventLocals type for a custom app typescript does not pickup the types until it the file also contains a top level import/export.

What is the new behavior?

Now instead of declare module we declare a namespace that does not confuse typescript and makes sure the global.d.ts is interpreted as an augmentation module (not ambient as before)

Other information

Related to #1466 unfortunately this would require current users to re-config their typings. (from module to namespace)

@changeset-bot changeset-bot
Copy link

changeset-bot bot commented May 5, 2024 •
edited
Loading

🦋 Changeset detected

Latest commit: 92f0c57

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@solidjs/start Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@AirBorne04 AirBorne04 mentioned this pull request May 5, 2024
Open
2 tasks
@ryansolid
Copy link
Member

I haven't touched this one since it is marked as draft. Are there more changes, or things that need to be verified?

@AirBorne04
Copy link
Contributor Author

AirBorne04 commented Jun 19, 2024 •
edited
Loading

hi @ryansolid mainly looking for approval, and adjustment on the docs side? Any thoughts?

I have tested again today, since its been a while, it all looks good still. The one docs adjustment that we would need is to now define the RequestEventLocals in the project like this:

declare module App {
  interface RequestEventLocals {
    myNumber: number
    someString: string
  }
}

Also added this into the todomvc example app for further reference.

@AirBorne04 AirBorne04 marked this pull request as ready for review June 21, 2024 07:36
@doeixd doeixd mentioned this pull request Jun 21, 2024
Open
@ryansolid
Copy link
Member

Ok I like it. We probably have to wait for minor given how this could break types. I've broken types on patch releases before but I feel like we should be cautious here.

@AirBorne04
Copy link
Contributor Author

Ok I like it. We probably have to wait for minor given how this could break types. I've broken types on patch releases before but I feel like we should be cautious here.

Perfect, I feel the same, I have updated the changeset accordingly.

@pkg-pr-new pkg.pr.new
Copy link

pkg-pr-new bot commented Oct 31, 2024

Open in Stackblitz

More templates

pnpm add https://pkg.pr.new/@solidjs/start@1469

commit: 92f0c57

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@AirBorne04 @ryansolid